sensor-service API

sensor-service supports 7 commands:

Services: pos eve edp status route sensor msg cfg asset mod map sys tftp eng tag rec aprec test index

/epe/sensor/configurationedit POST version		Input:	Output:
	Description: Edit sensor configuration. Example 1: Set temperature calibration value of tag 1 /epe/sensor/configurationedit?tagid=1&tempcalibration=-0.5 Example 2: Reset temperature calibration value of tag 1 /epe/sensor/configurationedit?tagid=1&tempcalibration= Role Required: tagoperator Call Counter: Total: 0, Failed: 0	certificatenumber (required) - [String] certificate number of reference device tagid (optional) - [long] tag id mac (optional) - [String] MAC address of the device tempcalibration (optional) - [float] temperature calibration value in (deg C) tempcalibration2 (optional) - [float] second probe temperature calibration value in (deg C)
/epe/sensor/configurationget POST version		Input:	Output:
	Description: Get sensor configuration. Example 1: Get configuration of tag 1 /epe/sensor/configurationget?tagid=1 Role Required: viewer Call Counter: Total: 0, Failed: 0	tagid (optional) - [long] tag id mac (optional) - [String] MAC address of the device	CONFIGURATION.tagid - [long] tag id CONFIGURATION.tempcalibration - [float] temperature calibration value in (deg C) CONFIGURATION.tempcalibration2 - [float] second probe temperature calibration value in (deg C) CONFIGURATION.certificatenumber - [String] certificate number of reference device
/epe/sensor/sensorhistory POST version		Input:	Output:
	Description: Lists sensor history. Role Required: viewer Call Counter: Total: 21, Failed: 0	tagid (optional) - [Array] list entries related to specific devices, specified by device ids mac (optional) - [Array] list entries related to specific devices, specified by MAC addresses assetid (optional) - [Array] list entries related to specific assets, specified by asset ids since (optional) - [String] list entries since the specified time. there are two alternative formats; the point of time can be given as milliseconds elapsed since midnight UTC of January 1, 1970. another option is to use the ISO 8601 notation (yyyy-MM-dd hh:mm:ssZ). time zone is optional; if it's omitted, the input is interpreted as server's local time until (optional) - [String] list entries until the specified time. format is the same as with since within (optional) - [String] list entries occured within the given time period, format 1s for one second, 2m for two minutes, 3h for three hours, 4d for four days time (optional) - [long] sensor measurement timestamp numlatest (optional) - [int] max number of entries to list, newest first numoldest (optional) - [int] max number of entries to list, oldest first sort (optional) - [String] sorts output into given order. Allowed values are 'ascending' and 'descending'. Can not be used simultaneously with 'numlatest' or 'numoldest' streaming (optional) - [String] if set to true, returns history as a stream format (optional) - [String] format of output, compact or xml; default is xml	SENSOR.tagid - [long] id of a device SENSOR.assetid - [long] asset identifier SENSOR.mac - [String] MAC address of a device SENSOR.time - [String] measurement time stamp in milliseconds since January 1, 1970, 00:00:00 GMT SENSOR.reason - [int] measurement reason, one of the following: 1=Button, 2=Motion, 3=Periodic, 4=Calibrate, 5=After motion, 6=Button2, 7=Tamper alarm, 8=Button3, 9=Charger status, 10=Safety switch status, 11=Low battery, 12=Motion stagnant, 13=Menu selection, 14=Supplementary, 15=Location beacon, 16=Priority message ack, 17=Battery level changed, 20=Network SENSOR.batterylevel - [int] device battery level, range 0-100, or null if N/A SENSOR.datatype - [Array] measurement data type, one of the following: TEMP_C, TEMP2_C, HUMIDITY SENSOR.datavalue - [Array] measurement data value, format depends on the type SENSOR.alarm - [int] sensor alarm indicator, device type specific value SENSOR.logrecord - [String] If TRUE, indicates that the information received from the tag is a log record
/epe/sensor/sensorstream POST version		Input:	Output:
	Description: Receive new sensor data measurements in real time. The connection stays active forever. Whenever a new sensor measurement is available, RTLS Controller sends the sensor data to the caller. Role Required: viewer Call Counter: Total: 3, Failed: 2	format (optional) - [String] format of output, compact or xml; default is xml	SENSOR.tagid - [long] tag id SENSOR.assetid - [long] asset identifier SENSOR.mac - [String] MAC address SENSOR.name - [String] device name SENSOR.type - [String] device type (such as ts1 or ts2) SENSOR.reason - [int] measurement reason, one of the following: 1=Button, 2=Motion, 3=Periodic, 4=Calibrate, 5=After motion, 6=Button2, 7=Tamper alarm, 8=Button3, 9=Charger status, 10=Safety switch status, 11=Low battery, 12=Motion stagnant, 13=Menu selection, 14=Supplementary, 15=Location beacon, 16=Priority message ack, 17=Battery level changed, 20=Network SENSOR.batterylevel - [int] device battery level, range 0-100, or null if N/A SENSOR.time - [long] measurement time stamp in milliseconds since January 1, 1970, 00:00:00 GMT SENSOR.datatype - [Array] measurement data type, one of the following: TEMP_C, TEMP2_C, HUMIDITY SENSOR.datavalue - [Array] measurement data value, format depends on the type SENSOR.alarm - [int] sensor alarm indicator, device type specific value SENSOR.logrecord - [String] If TRUE, indicates that the information received from the tag is a log record
/epe/sensor/_clear		Input:	Output:
	Description: SPECIAL. Resets all service specific counters. Role Required: poweruser Call Counter: Total: 0, Failed: 0
/epe/sensor/_list POST version		Input:	Output:
	Description: SPECIAL. Lists the available commands, their arguments, responses, required roles, call counters and optional help descriptions. Role Required: Call Counter: Total: 1, Failed: 0	help (optional) - [int] set to 1 to get also HTML help description of the commands. Default is 0.	COMMAND.name - [String] command name COMMAND.arg - [String] mandatory argument COMMAND.optarg - [String] optional argument COMMAND.response - [String] response field COMMAND.internal - [int] 1 for internal command COMMAND.role - [String] required role COMMAND.callcount - [int] number of calls COMMAND.callcountinternal - [int] number of internal calls COMMAND.callcountfailure - [int] number of failed calls COMMAND.htmlhelp - [String] command description in HTML format
/epe/sensor/_status		Input:	Output:
	Description: SPECIAL. Returns status information about the service. Role Required: viewer Call Counter: Total: 0, Failed: 0		STATUS.callcount - [int] total number of calls for the service STATUS.callcountinternal - [int] total number of internal calls for the service STATUS.callcountfailure - [int] total number of failed calls for the service STATUS.commandcount - [int] number of commands in service STATUS.* - [String] service specific status information

(The data in this page was generated from /epe/sensor/_list?help=1)